PDM-IR_SDK custom Types

Data Structures
struct	Temperature_s
struct	MODULECONFIG
struct	MODULEINFO
struct	MODULESTATUS

Typedefs
typedef unsigned char	UINT8
typedef signed char	INT8
typedef signed short	INT16
typedef unsigned short	UINT16
typedef unsigned int	UINT32
typedef signed int	INT32

Enumerations
enum	RESULT {   RESULT_OK, RESULT_DATA_OUT_LIMIT_HIGH, RESULT_DATA_OUT_LIMIT_LOW, RESULT_DATA_ERROR,   RESULT_ERROR_COMMUNICATION }
enum	TEMP_VALUES { THIGH = 0, TMEDIUM = 1, TLOW = 2, TLOWEST = 3 }
enum	HOLDOFFTYPE { HOLDOFFTYPE_EDGE = 0, HOLDOFFTYPE_LEVEL = 1 }
enum	GATEMODE { GATEMODE_INTERNAL = 0, GATEMODE_EXTERNAL = 1 }
enum	GATESHAPE { GATESHAPE_FIXEDGATE = 0, GATESHAPE_FREEGATE = 1, GATESHAPE_FREERUNNING = 2 }
enum	TREDGE { TREDGE_LH = 0, TREDGE_HL = 1 }
enum	TRFUNCT {   In_AND_Aux = 0, In_OR_Aux = 1, In_XOR_Aux = 2, notIn_AND_Aux = 3,   notIn_OR_Aux = 4, notIn_XOR_Aux = 5, In_AND_notAux = 6, In_OR_notAux = 7,   In_XOR_notAux = 8, notIn_AND_notAux = 9, notIn_OR_notAux = 10, notIn_XOR_notAux = 11,   In_NAND_Aux = 12, In_NOR_Aux = 13, In_XNOR_Aux = 14, notIn_NAND_Aux = 15,   notIn_NOR_Aux = 16, notIn_XNOR_Aux = 17, In_NAND_notAux = 18, In_NOR_notAux = 19,   In_XNOR_notAux = 20, notIn_NAND_notAux = 21, notIn_NOR_notAux = 22, notIn_XNOR_notAux = 23,   only_notIN = 24, only_IN = 25 }
enum	OUTMODE {   OUTMODE_TRIGGERGATE = 0, OUTMODE_PHOTONOUT = 1, OUTMODE_HOLDOFF = 2, OUTMODE_VALIDGATE = 3,   OUTMODE_INTERNALTRIGGER = 4, OUTMODE_MODULESTATUS = 5 }
enum	COUNTERSTATUS { COUNTERSTATUS_OFF = 0, COUNTERSTATUS_ON = 1, COUNTERSTATUS_Continuous = 2 }
enum	SPAD_TYPE {   TYPE_1 = 0x1, TYPE_2 = 0x2, TYPE_3 = 0x3, TYPE_4 = 0x4,   TYPE_5 = 0x5 }
enum	STATUSBITS {   STATUSBITS_OFF = 0, STATUSBITS_ON = 1, STATUSBITS_Updating = 2, STATUSBITS_SafeValue = 3,   STATUSBITS_ToBeUpdated = 4, STATUSBITS_Updated = 5 }

Detailed Description

Custom types used by the SDK.

Enumeration Type Documentation

enum RESULT

Error table enum.

Error code returned by the PDM-IR functions.

Enumerator
RESULT_OK	result as expected. No errors.
RESULT_DATA_OUT_LIMIT_HIGH	At least one of the input values are above the maximum value accepted.
RESULT_DATA_OUT_LIMIT_LOW	At least one of the input values are below the minimum value accepted.
RESULT_DATA_ERROR	Error parsing the values referenced.
RESULT_ERROR_COMMUNICATION	Error communicating with the module.

enum TEMP_VALUES

Temperature enum.

Temperature of the SPAD.

Enumerator
THIGH	High temperature: the dark count rate is the highest than other temperature modes, but no particular caution is required for module thermal stability.
TMEDIUM	Medium temperature: the dark count rate is the one shown in the test report. In this case the module requires to be placed on a reasonable heat sink for uninterrupted operation.
TLOW	Low temperature: the dark count rate is very low. In this case the module requires a very good heath sink for optimal thermal dissipation and uninterrupted operation.
TLOWEST	Lowest temperature: the dark count rate is the lowest as possible. In this case the module requires a very good heath sink for thermal dissipation and a fan, in order to work without errors. Also, a low ambient temperature (of about 20-22C) will be required.

enum HOLDOFFTYPE

hold Off Type enum.

The enum select the PDM-IR hold off type.

Enumerator
HOLDOFFTYPE_EDGE	When the hold off time is over, the gate is not applied until the next rising edge of the gate window.
HOLDOFFTYPE_LEVEL	The Gate window is applied after the hold off time is over. This type is required in free running mode

enum GATEMODE

Gate Mode enum.

The enum select the PDM-IR internal or external trigger. The chose trigger is in logic function with the Aux In

See also

TRFUNCT

Enumerator
GATEMODE_INTERNAL	The Gate trigger is the internal trigger.
GATEMODE_EXTERNAL	The Gate trigger is the external trigger.

enum GATESHAPE

Gate Shape enum.

The enum specifies if the PDM-IR has a fixed width gate or the same width of the trigger gate, or is in free runing mode.

Enumerator
GATESHAPE_FIXEDGATE	The Gate has a fixed width determinated by the Ton.
GATESHAPE_FREEGATE	The Gate has the same digital shape and duration of the trigger gate signal.
GATESHAPE_FREERUNNING	The SPAD is always on when not in hold off.

enum TREDGE

Edge Type enum.

it selects the Edge sensitivity of the input.

Enumerator
TREDGE_LH	Rising Edge Trigger.
TREDGE_HL	Falling Edge Trigger.

enum TRFUNCT

Function Type enum.

Function between the trigger (Internal Trigger or Trigger In chosen by GATEMODE) and the Aux In.

See also

GATEMODE

Enumerator
In_AND_Aux	Selected trigger AND Aux In.
In_OR_Aux	Selected trigger OR Aux In.
In_XOR_Aux	Selected trigger XOR Aux In.
notIn_AND_Aux	Inverted Selected trigger AND Aux In.
notIn_OR_Aux	Inverted Selected trigger OR Aux In.
notIn_XOR_Aux	Inverted Selected trigger XOR Aux In.
In_AND_notAux	Selected trigger AND Inverted Aux In.
In_OR_notAux	Selected trigger OR Inverted Aux In.
In_XOR_notAux	Selected trigger XOR Inverted Aux In.
notIn_AND_notAux	Inverted Selected trigger AND Inverted Aux In.
notIn_OR_notAux	Inverted Selected trigger OR Inverted Aux In.
notIn_XOR_notAux	Inverted Selected trigger XOR Inverted Aux In.
In_NAND_Aux	Selected trigger NAND Aux In.
In_NOR_Aux	Selected trigger NOR Aux In.
In_XNOR_Aux	Selected trigger XNOR Aux In.
notIn_NAND_Aux	Inverted Selected trigger NAND Aux In.
notIn_NOR_Aux	Inverted Selected trigger NOR Aux In.
notIn_XNOR_Aux	Inverted Selected trigger XNOR Aux In.
In_NAND_notAux	Selected trigger NAND Inverted Aux In.
In_NOR_notAux	Selected trigger NOR Inverted Aux In.
In_XNOR_notAux	Selected trigger XNOR Inverted Aux In.
notIn_NAND_notAux	Inverted Selected trigger NAND Inverted Aux In.
notIn_NOR_notAux	Inverted Selected trigger NOR Inverted Aux In.
notIn_XNOR_notAux	Inverted Selected trigger XNOR Inverted Aux In.
only_notIN	Inverted Selected trigger.
only_IN	Selected trigger.

enum OUTMODE

Output Type enum.

it specifies the signal out from TLL out or NIM out.

Enumerator
OUTMODE_TRIGGERGATE	The Output reproduces the trigger gate signal.
OUTMODE_PHOTONOUT	The Output reproduces the photon out signal.
OUTMODE_HOLDOFF	The Output reproduces the hold off signal.
OUTMODE_VALIDGATE	The Output reproduces the valid gate signal.
OUTMODE_INTERNALTRIGGER	The Output reproduces the internal trigger signal.
OUTMODE_MODULESTATUS	The Output is high in case of error of the module (electrical signal of the RED led)

enum COUNTERSTATUS

Counter Status enum.

It indicates the couter status.

Enumerator
COUNTERSTATUS_OFF	The Counter is disabled.
COUNTERSTATUS_ON	The Counter is enabled only for one period.
COUNTERSTATUS_Continuous	The Counter is enabled.

enum SPAD_TYPE

SPAD Type enum.

The SPAD type used in the module.

Enumerator
TYPE_1	useful parameter for device statistics. Type1.
TYPE_2	useful parameter for device statistics. Type2.
TYPE_3	useful parameter for device statistics. Type3.
TYPE_4	useful parameter for device statistics. Type4.
TYPE_5	useful parameter for device statistics. Type5.

enum STATUSBITS

Parameter Status enum.

The enum indicates the actual status of a parameter.

Enumerator
STATUSBITS_OFF	The Parameter is disabled.
STATUSBITS_ON	The Parameter is enabled.
STATUSBITS_Updating	The Parameter is updating the state.
STATUSBITS_SafeValue	The Parameter has a safe value, used before update the value waiting the right update order.
STATUSBITS_ToBeUpdated	The Parameter needs to be updated.
STATUSBITS_Updated	The Parameter is updated.